Skip to content

Add API Hello World guide#65

Open
wbrennan899 wants to merge 5 commits intomainfrom
willbrennan/add-api-hello-world-guide
Open

Add API Hello World guide#65
wbrennan899 wants to merge 5 commits intomainfrom
willbrennan/add-api-hello-world-guide

Conversation

@wbrennan899
Copy link
Collaborator

Add API Hello World guide

Adds a step-by-step guide to the API tab that walks through the complete instance lifecycle using curl:

  1. Get an API key
  2. Verify authentication
  3. Search for GPUs (with filter parameter explanations)
  4. Create an instance
  5. Poll until ready
  6. Stop/destroy to clean up

Every command in this guide has been tested end-to-end against the live API. The verification report is in the customer-work repo.

Changes

  • api-reference/hello-world.mdx — new guide
  • docs.json — added nav entry under API Reference (after Introduction, before Permissions)

Copy link
Contributor

@robballantyne robballantyne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Notes added to internal tracker

wbrennan899 and others added 3 commits February 23, 2026 15:54
- Fix API key generation link to point to Keys page
- Change search sort to dlperf_per_dphtotal, increase limit to 5
- Add cost estimate, disk size clarification, instance_api_key description
- Add SSH connection step (step 6), reorder clean up to step 7
- Swap destroy/stop order, add onstart callback mention
- Link to Search Offers reference, consolidate Next Steps

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace the minimal API introduction with the Hello World guide content,
remove the now-redundant hello-world.mdx, and add a redirect.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add Python code tabs alongside curl for all API steps using CodeGroup.
Restore advanced-users-only warning that was on main.
…sh_direct, show instance link

- Expand intro to describe full API scope
- Add scoped API keys tip with link to Create API Key endpoint
- Switch auth step to /users/current/ endpoint
- Add template-based instance creation with link to Templates guide
- Add ssh_direct runtype to create params
- Fix instance_api_key description to include GET access
- Add Show Instance endpoint link in polling section
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants